syntax(3.22.1)             Syntax                  version(1.0)

NAME
	syntax - a manual on the syntax used in help commands

SYNOPSIS
	man syntax
	man syntax nlp
	man syntax eon

DESCRIPTION
	syntax is the structure used to describe the format of help and
	nlp (natural language processing) commands.

OPTIONS
	nlp     Used to describe the syntax used in the nlp parser
	eon     Used to describe the syntax in the eon parser

OVERVIEW
	The syntax used in the help system follows an EBNF format.
	[ ]     Items enclosed in braces are optional.
    < >     Items enclosed in brackets represent types of objects.
    ( )     Items in parentheses are grouped together.
     |      Items separated by a pipe are read as "or"
	Items listed without any of the above decorations are literals.

EXAMPLES
	about
	Issues the 'about' command by itself.

	afk [message]
	This means you can either use the afk command by itself, or with an
	optional [message] parameter.

	agency [(list|create <name>|destroy <name>|admin)]
	This is a more complex example. This syntax string represents the
	following commands:
	agency
	agency list
	agency create <name>
	agency destroy <name>
	agency admin
	The square braces mean those command are optional.  The parentheses
	group all of those commands together, meaning there's only going to
	be one optional parameter out of the list.  The pipes separate the
	optional commands in the group while the brackets list the required
	parameters to the previously listed command.

FILES
	/data/help/syntax.man
		The syntax manual

SEE ALSO
	nlp(3.22.4), eon(3.22.5)

HISTORY
	22 May 2011 - Initial draft by B. Gian James (control@government-sanctioned.us)

